/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.apache.flink.connector.jdbc.internal;

import org.apache.flink.annotation.Internal;
import org.apache.flink.api.common.ExecutionConfig;
import org.apache.flink.api.common.functions.RuntimeContext;
import org.apache.flink.api.common.typeinfo.TypeInformation;
import org.apache.flink.api.java.typeutils.InputTypeConfigurable;
import org.apache.flink.configuration.Configuration;
import org.apache.flink.runtime.state.FunctionInitializationContext;
import org.apache.flink.runtime.state.FunctionSnapshotContext;
import org.apache.flink.streaming.api.checkpoint.CheckpointedFunction;
import org.apache.flink.streaming.api.functions.sink.RichSinkFunction;
import org.apache.flink.util.Preconditions;

import javax.annotation.Nonnull;

import java.io.IOException;

/** A generic SinkFunction for JDBC. */
@Internal
public class GenericJdbcSinkFunction<T> extends RichSinkFunction<T>
        implements CheckpointedFunction, InputTypeConfigurable {
    
    // 这是一个私有的不可变成员变量，它的类型是JdbcOutputFormat<T, ?, ?>。
    // 这种类型通常在使用泛型时使用，其中T是一个具体的类型，而 ?是一个未知的类型。

    // JdbcOutputFormat<T, ?, ?> 可能是一个自定义的类，用于定义如何将数据输出到 JDBC数据源。
    // 这个类可能有多个类型参数，其中第一个参数 T可能用于指定要处理的数据的类型，
    // 而其他两个参数可能用于其他目的，具体取决于 JdbcOutputFormat类的实现。
    private final JdbcOutputFormat<T, ?, ?> outputFormat;

    public GenericJdbcSinkFunction(@Nonnull JdbcOutputFormat<T, ?, ?> outputFormat) {
        this.outputFormat = Preconditions.checkNotNull(outputFormat);
    }

    /**
     * 这段代码是一个重写的 open方法，通常在处理数据流或者资源初始化的时候会用到。
     *
     * @param parameters 包含附加到合约的参数的配置.
     * @throws Exception
     */
    @Override
    public void open(Configuration parameters) throws Exception {
        // 首先，这个方法通过 super.open(parameters);
        // 调用了父类的 open方法，传入了 parameters参数。
        super.open(parameters);
        //然后，通过 getRuntimeContext()方法获取了当前的运行上下文 RuntimeContext。
        RuntimeContext ctx = getRuntimeContext();
        // 接着，使用 setRuntimeContext(ctx)方法将运行上下文设置到了 outputFormat对象中。
        outputFormat.setRuntimeContext(ctx);
        // 最后，调用了 outputFormat.open()方法，传入了子任务的索引ctx.getIndexOfThisSubtask()
        // 和并行子任务的数量 ctx.getNumberOfParallelSubtasks()。
        // 这可能是为了让 outputFormat知道当前是在哪个子任务中以及总共有多少个并行的子任务。
        outputFormat.open(ctx.getIndexOfThisSubtask(), ctx.getNumberOfParallelSubtasks());
    }

    @Override
    public void invoke(T value, Context context) throws IOException {
        outputFormat.writeRecord(value);
    }

    @Override
    public void initializeState(FunctionInitializationContext context) {}

    @Override
    public void snapshotState(FunctionSnapshotContext context) throws Exception {
        outputFormat.flush();
    }

    @Override
    public void close() {
        outputFormat.close();
    }

    @Override
    public void setInputType(TypeInformation<?> type, ExecutionConfig executionConfig) {
        outputFormat.setInputType(type, executionConfig);
    }
}
